/*
 * Copyright (c) 2008-2010, JFXtras Group
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of JFXtras nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package org.jfxtras.ext.swing.table;

/**
 * Base class for defining cell types.
 *
 * @profile desktop
 * @author John Freeman
 */
public abstract class Cell {

    /**
     * Row containing this cell.
     */
    package var row:Row;

    /**
     * Column containing this cell.
     */
    package var columnIndex:Integer;

    /**
     * Returns the cell value.
     */
    protected abstract function getValue():Object;

    /**
     * Sets the cell value.
     */
    protected abstract function setValue(value:Object):Void;

    /**
     * Action called when value changed.
     */
    protected function valueChanged():Void {
        if (row != null) {
            row.valueChanged(columnIndex);
        }
    }

    /**
     * Whether this cell is editable. The {@code value} should also be bound using {@code with inverse} for editing to
     * function properly.
     *
     * @defaultvalue false
     * @see #isEditable()
     */
    public var editable:Boolean = false;

    /**
     * Whether this cell is editable. Note this function takes preference over the {@link #editable} variable.
     */
    public function isEditable() {
        return editable;
    }

    /**
     * Returns the Java type of this column.
     *
     * @see javax.swing.table.TableModel#getColumnClass(int)
     */
    public abstract function getColumnClass():java.lang.Class;

    override function toString() {
        return "{getValue()}";
    }
}
